<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DM-CtrlH7-BF-DevProgram: C:/Users/ASUS/Desktop/dm-ctrlH7-balance-9025test/bsp/usart/bsp_usart.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="50x5.png"/></td>
  <td id="projectalign">
   <div id="projectname">DM-CtrlH7-BF-DevProgram<span id="projectnumber">&#160;beta 0.1</span>
   </div>
   <div id="projectbrief">C.ONE Studio Damiao Development Board Framework</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(function(){initNavTree('bsp__usart_8h_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">bsp_usart.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="preprocessor">#ifndef BSP_RC_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#define BSP_RC_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="preprocessor">#include &quot;<a class="code" href="main_8h.html">main.h</a>&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#define DEVICE_USART_CNT 3     </span><span class="comment">// C板至多分配3个串口</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define USART_RXBUFF_LIMIT 256 </span><span class="comment">// 如果协议需要更大的buff,请修改这里</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">// 模块回调函数,用于解析协议</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="keyword">typedef</span> void (*usart_module_callback)();</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">/* 发送模式枚举 */</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span>{</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>    USART_TRANSFER_NONE=0,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>    USART_TRANSFER_BLOCKING,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>    USART_TRANSFER_IT,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>    USART_TRANSFER_DMA,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>} USART_TRANSFER_MODE;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment">// 串口实例结构体,每个module都要包含一个实例.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment">// 由于串口是独占的点对点通信,所以不需要考虑多个module同时使用一个串口的情况,因此不用加入id;当然也可以选择加入,这样在bsp层可以访问到module的其他信息</span></div>
<div class="foldopen" id="foldopen00024" data-start="{" data-end="};">
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="struct_u_s_a_r_t_instance.html">   24</a></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>    uint8_t recv_buff[USART_RXBUFF_LIMIT]; <span class="comment">// 预先定义的最大buff大小,如果太小请修改USART_RXBUFF_LIMIT</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>    uint8_t recv_buff_size;                <span class="comment">// 模块接收一包数据的大小</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>    <a class="code hl_typedef" href="group___u_a_r_t___exported___types.html#ga5de4a49eb132735325e706f406c69d6e">UART_HandleTypeDef</a> *usart_handle;      <span class="comment">// 实例对应的usart_handle</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>    usart_module_callback module_callback; <span class="comment">// 解析收到的数据的回调函数</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>} <a class="code hl_struct" href="struct_u_s_a_r_t_instance.html">USARTInstance</a>;</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">/* usart 初始化配置结构体 */</span></div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="struct_u_s_a_r_t___init___config__s.html">   33</a></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    uint8_t recv_buff_size;                <span class="comment">// 模块接收一包数据的大小</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>    <a class="code hl_typedef" href="group___u_a_r_t___exported___types.html#ga5de4a49eb132735325e706f406c69d6e">UART_HandleTypeDef</a> *usart_handle;      <span class="comment">// 实例对应的usart_handle</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>    usart_module_callback module_callback; <span class="comment">// 解析收到的数据的回调函数</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>} <a class="code hl_struct" href="struct_u_s_a_r_t___init___config__s.html">USART_Init_Config_s</a>;</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><a class="code hl_struct" href="struct_u_s_a_r_t_instance.html">USARTInstance</a> *<a class="code hl_function" href="bsp__usart_8c.html#a4296c218240b51944ecb698eed2625ef">USARTRegister</a>(<a class="code hl_struct" href="struct_u_s_a_r_t___init___config__s.html">USART_Init_Config_s</a> *init_config);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="keywordtype">void</span> <a class="code hl_function" href="bsp__usart_8c.html#ac45bba3591501c066f505a46dbae7e2b">USARTServiceInit</a>(<a class="code hl_struct" href="struct_u_s_a_r_t_instance.html">USARTInstance</a> *_instance);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="keywordtype">void</span> <a class="code hl_function" href="bsp__usart_8c.html#a12acc10fbb458df894b53534ae66c25d">USARTSend</a>(<a class="code hl_struct" href="struct_u_s_a_r_t_instance.html">USARTInstance</a> *_instance, uint8_t *send_buf, uint16_t send_size,USART_TRANSFER_MODE mode);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>uint8_t <a class="code hl_function" href="bsp__usart_8c.html#a4a4a562d3a505abe103d09f65ef860e4">USARTIsReady</a>(<a class="code hl_struct" href="struct_u_s_a_r_t_instance.html">USARTInstance</a> *_instance);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="absp__usart_8c_html_a12acc10fbb458df894b53534ae66c25d"><div class="ttname"><a href="bsp__usart_8c.html#a12acc10fbb458df894b53534ae66c25d">USARTSend</a></div><div class="ttdeci">void USARTSend(USARTInstance *_instance, uint8_t *send_buf, uint16_t send_size, USART_TRANSFER_MODE mode)</div><div class="ttdoc">通过调用该函数可以发送一帧数据,需要传入一个usart实例,发送buff以及这一帧的长度</div><div class="ttdef"><b>Definition</b> bsp_usart.c:62</div></div>
<div class="ttc" id="absp__usart_8c_html_a4296c218240b51944ecb698eed2625ef"><div class="ttname"><a href="bsp__usart_8c.html#a4296c218240b51944ecb698eed2625ef">USARTRegister</a></div><div class="ttdeci">USARTInstance * USARTRegister(USART_Init_Config_s *init_config)</div><div class="ttdoc">注册一个串口实例,返回一个串口实例指针</div><div class="ttdef"><b>Definition</b> bsp_usart.c:38</div></div>
<div class="ttc" id="absp__usart_8c_html_a4a4a562d3a505abe103d09f65ef860e4"><div class="ttname"><a href="bsp__usart_8c.html#a4a4a562d3a505abe103d09f65ef860e4">USARTIsReady</a></div><div class="ttdeci">uint8_t USARTIsReady(USARTInstance *_instance)</div><div class="ttdoc">判断串口是否准备好,用于连续或异步的IT/DMA发送</div><div class="ttdef"><b>Definition</b> bsp_usart.c:83</div></div>
<div class="ttc" id="absp__usart_8c_html_ac45bba3591501c066f505a46dbae7e2b"><div class="ttname"><a href="bsp__usart_8c.html#ac45bba3591501c066f505a46dbae7e2b">USARTServiceInit</a></div><div class="ttdeci">void USARTServiceInit(USARTInstance *_instance)</div><div class="ttdoc">启动串口服务,会在每个实例注册之后自动启用接收,当前实现为DMA接收,后续可能添加IT和BLOCKING接收</div><div class="ttdef"><b>Definition</b> bsp_usart.c:29</div></div>
<div class="ttc" id="agroup___u_a_r_t___exported___types_html_ga5de4a49eb132735325e706f406c69d6e"><div class="ttname"><a href="group___u_a_r_t___exported___types.html#ga5de4a49eb132735325e706f406c69d6e">UART_HandleTypeDef</a></div><div class="ttdeci">struct __UART_HandleTypeDef UART_HandleTypeDef</div><div class="ttdoc">UART handle Structure definition.</div></div>
<div class="ttc" id="amain_8h_html"><div class="ttname"><a href="main_8h.html">main.h</a></div><div class="ttdoc">: Header for main.c file. This file contains the common defines of the application.</div></div>
<div class="ttc" id="astruct_u_s_a_r_t___init___config__s_html"><div class="ttname"><a href="struct_u_s_a_r_t___init___config__s.html">USART_Init_Config_s</a></div><div class="ttdef"><b>Definition</b> bsp_usart.h:34</div></div>
<div class="ttc" id="astruct_u_s_a_r_t_instance_html"><div class="ttname"><a href="struct_u_s_a_r_t_instance.html">USARTInstance</a></div><div class="ttdef"><b>Definition</b> bsp_usart.h:25</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="dir_3c5459f7c179b79c90e2565474bb2856.html">bsp</a></li><li class="navelem"><a href="dir_8f31272b2552570da9d5b13ae61f54f3.html">usart</a></li><li class="navelem"><b>bsp_usart.h</b></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
  </ul>
</div>
</body>
</html>
